ci: turn the Renovate PR body into a step-by-step guide - #44
Merged
Conversation
The note said to run start locally and left the rest to memory. It is now the whole sequence: get the branch, clear what is running, point the local config at the new version, start it, check the probe, add the changeset. Two of those steps exist because the obvious command does the wrong thing. `init` never overwrites an existing config, so without --force the reviewer tests the old version. And Splice pins container_name on every service, so those names are global to Docker and a leftover from an earlier run stops the start with a name conflict.
github-project-automation
Bot
moved this from Backlog
to Done
in Canton - dAppBooster (#390)
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Related to #35.
The note Renovate put on #42 said "run
startlocally before merging" and left the rest to memory. Verifying a Splice bump is six steps, two of which fail in confusing ways if you run the obvious command, so the reviewer had to remember all of it months apart.Changes
prBodyNotesis now the full sequence: get the branch, clear what is running, point the local config at the new version, start it, check the probe, add the changeset.Two steps are there because the obvious command does the wrong thing:
initnever overwrites an existing config, so without--forceyou keep testing the old version while believing you tested the new one.container_nameon all 14 services, so those names are global to Docker rather than scoped to the compose project. A container left by an earlier run stops the start withConflict. The container name "/postgres" is already in use, which is what happened while checking chore(deps): update dependency canton-network/splice to v0.7.5 #42. The guide now removes those leftovers by name.Each fenced block is a single
prBodyNotesentry, because Renovate puts a blank line between entries and the old note rendered as a code block with gaps between every command.Acceptance criteria
Test plan
Automated tests
None.
renovate-config-validatorpasses.Manual verification
Rendered the notes with the templates filled in and read the result as it will appear on the PR. The container filter was run against a live stack: it matches the 14 Splice containers and nothing else.
Breaking changes
None.
Checklist
Screenshots
None.